/*
 *  Copyright (C) 2010 glauco
 * 
 *  This program is free software: you can redistribute it and/or modify
 *  it under the terms of the GNU General Public License as published by
 *  the Free Software Foundation, either version 3 of the License, or
 *  (at your option) any later version.
 * 
 *  This program is distributed in the hope that it will be useful,
 *  but WITHOUT ANY WARRANTY; without even the implied warranty of
 *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 *  GNU General Public License for more details.
 * 
 *  You should have received a copy of the GNU General Public License
 *  along with this program.  If not, see <http://www.gnu.org/licenses/>.
 */

package org.balisunrise.common;

/**
 *
 * @author glauco
 */
public interface MenuAction {

    /**
     * Nome do Módulo da opção de menu.
     * @return Nome do Módulo.
     */
    public String getModule();

    /**
     * Caminho da opção nos menus.
     * Dividir os folders com '\' ou '/'.
     * @return Caminho
     */
    public String getFolder();

    /**
     * Retorna o nome da Ação.
     * @return Nome.
     */
    public String getName();

    /**
     * Retorna a descrição da Ação.
     * Esta descrição será usada nos menus.
     * @return Descrição.
     */
    public String getDescription();

    /**
     * Retorna a dica do que faz a ação.
     * @return Dica do que faz a ação.
     */
    public String getToolTipText();

    /**
     * Retorna o caminho de um icone para representar a ação.
     * @return Caminho do icone.
     */
    public String getIcon();

    /**
     * Retorna a Ação que deve ser executada por acionar o menu.
     * @return Ação a ser executada. Pode retornar nulo, caso não há evento
     * a ser executado.
     */
    public Action getAction();
}
